Web Import: Add New Entries to 'Imported Entries' Group #12998

paudelritij · 2025-04-25T00:36:58Z

Closes #12548
This PR introduce feature to add new group "Imported Entries"

To Do

Add test cases

Done

Add configurable field for Imported entries group in preferences
Create fields for Import entries group in library preferences
Link preferences configuration to BibEntry (for enable/disable and name of group)
web search entries, pdf import and web fetchers entries auto import into group 'import entries'
Introduce Smart Group 0 SmartGroup:Import entries\

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
[.] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
[.] Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
[.] Screenshots added in PR description (if change is visible to the user)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

…ence

jabref-machine · 2025-04-25T00:47:56Z

Note that your PR will not be reviewed/accepted until you have gone through the mandatory checks in the description and marked each of them them exactly in the format of [x] (done), [ ] (not done yet) or [/] (not applicable).

…r-issue-12548

trag-bot · 2025-05-04T12:41:06Z

jabgui/src/main/java/org/jabref/gui/externalfiles/ImportHandler.java

@@ -501,4 +504,17 @@ private List<BibEntry> handlePdfUrl(String pdfUrl) throws IOException {
            return List.of();
        }
    }
+
+    private void addToImportEntriesGroup(List<BibEntry> entryToInsert) {


The method name 'entryToInsert' is misleading as it suggests a single entry, but it is actually a list of entries. This can cause confusion and reduce code readability.

trag-bot · 2025-05-04T12:41:11Z

jabgui/src/main/java/org/jabref/gui/externalfiles/ImportHandler.java

@@ -501,4 +504,17 @@ private List<BibEntry> handlePdfUrl(String pdfUrl) throws IOException {
            return List.of();
        }
    }
+
+    private void addToImportEntriesGroup(List<BibEntry> entryToInsert) {


The method 'addToImportEntriesGroup' should not return null. It should use Optional to handle cases where no group is found, ensuring better null safety and code clarity.

trag-bot · 2025-05-04T12:41:35Z

jabgui/src/main/java/org/jabref/gui/groups/GroupDescriptions.java

@@ -61,6 +62,10 @@ public static String getShortDescriptionAllEntriesGroup() {
        return Localization.lang("<b>All Entries</b> (this group cannot be edited or removed)");
    }

+    public static String getShortDescriptionSmartGroup(SmartGroup smartGroup) {


The method getShortDescriptionSmartGroup returns a String, which could potentially be null. New public methods should not return null and should use java.util.Optional instead.

trag-bot · 2025-05-04T12:41:44Z

jabgui/src/main/java/org/jabref/gui/groups/GroupDescriptions.java

@@ -61,6 +62,10 @@ public static String getShortDescriptionAllEntriesGroup() {
        return Localization.lang("<b>All Entries</b> (this group cannot be edited or removed)");
    }

+    public static String getShortDescriptionSmartGroup(SmartGroup smartGroup) {
+        return Localization.lang("<b>Smart Group</b> (Import Entries)");


The string 'Smart Group' should be in sentence case as per the guidelines, so it should be 'Smart group'.

trag-bot · 2025-05-04T12:43:06Z

jabgui/src/main/java/org/jabref/gui/groups/GroupTreeNodeViewModel.java

@@ -17,6 +17,7 @@
 import org.jabref.model.groups.GroupTreeNode;
 import org.jabref.model.groups.KeywordGroup;
 import org.jabref.model.groups.SearchGroup;
+import org.jabref.model.groups.SmartGroup;


The code uses Java SWING imports, which contradicts the instruction to use only JavaFX for UI technology. This could lead to inconsistencies in the UI framework used.

trag-bot · 2025-05-04T12:44:06Z

jabgui/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java

+        boolean isGrpExist = parent.getGroupNode()
+                                 .getChildren()
+                                 .stream()
+                                 .map(GroupTreeNode::getGroup)
+                                 .anyMatch(grp -> grp instanceof SmartGroup);


The variable name isGrpExist does not follow camel-case naming convention. It should be renamed to isGroupExist for consistency.

trag-bot · 2025-05-04T12:44:58Z

jabgui/src/test/java/org/jabref/gui/groups/GroupTreeViewModelTest.java

@@ -47,6 +48,13 @@ void setUp() {
        preferences = mock(GuiPreferences.class);
        dialogService = mock(DialogService.class, Answers.RETURNS_DEEP_STUBS);

+        when(preferences.getLibraryPreferences()).thenReturn(new LibraryPreferences(


The patch adds a new mock for LibraryPreferences, but the method name 'getLibraryPreferences' does not follow camel-case naming convention.

trag-bot · 2025-05-04T12:44:58Z

jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTab.java

@@ -76,6 +78,10 @@ public void initialize() {
        downloadLinkedOnlineFiles.selectedProperty().bindBidirectional(viewModel.shouldDownloadLinkedOnlineFiles());
        keepDownloadUrl.selectedProperty().bindBidirectional(viewModel.shouldKeepDownloadUrl());

+        addImportedEntries.selectedProperty().bindBidirectional(viewModel.getAddImportedEntries());
+        addImportedEntriesGroupName.textProperty().bindBidirectional(viewModel.getAddImportedEntriesGroupName());
+        addImportedEntriesGroupName.disableProperty().bind(addImportedEntries.selectedProperty().not());


The variable name 'addImportedEntriesGroupName' should be in camel-case format, such as 'addImportedEntriesGroupName'.

trag-bot · 2025-05-04T12:46:27Z

jablib/src/main/java/org/jabref/logic/exporter/GroupSerializer.java

@@ -26,6 +27,19 @@ private static String serializeAllEntriesGroup() {
        return MetadataSerializationConfiguration.ALL_ENTRIES_GROUP_ID;
    }

+    private String serializeSmartGroup(SmartGroup group) {


The method serializeSmartGroup is private and returns a String. If this method is intended to be used externally, it should return an Optional instead of null, following modern Java practices.

trag-bot · 2025-05-04T12:47:27Z

jablib/src/main/java/org/jabref/logic/importer/util/GroupsParser.java

@@ -206,6 +210,24 @@ private static KeywordGroup keywordGroupFromString(String s, Character keywordSe
        return newGroup;
    }

+    private static SmartGroup smartGroupFromString(String input, Character keywordSeparator) throws ParseException {
+        if (!input.startsWith(MetadataSerializationConfiguration.SMART_GROUP_ID)) {


Using exceptions for control flow is not recommended. Instead of throwing an IllegalArgumentException, consider using a different approach to handle this condition.

trag-bot · 2025-05-04T12:48:28Z

jablib/src/main/java/org/jabref/logic/exporter/GroupSerializer.java

@@ -26,6 +27,19 @@ private static String serializeAllEntriesGroup() {
        return MetadataSerializationConfiguration.ALL_ENTRIES_GROUP_ID;
    }

+    private String serializeSmartGroup(SmartGroup group) {


The method serializeSmartGroup is private and returns a String. According to the special instructions, new public methods should not return null and should use java.util.Optional. Consider making this method public and returning Optional.

trag-bot · 2025-05-04T12:49:34Z

jablib/src/main/java/org/jabref/logic/importer/util/GroupsParser.java

@@ -206,6 +210,24 @@ private static KeywordGroup keywordGroupFromString(String s, Character keywordSe
        return newGroup;
    }

+    private static SmartGroup smartGroupFromString(String input, Character keywordSeparator) throws ParseException {


The method 'smartGroupFromString' throws a ParseException for normal control flow when parsing context fails. Exceptions should be used for exceptional states, not for normal control flow.

jabref-machine · 2025-05-04T12:49:36Z

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Checkstyle (pull_request)" and click on it.

In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues, commit, and push.

trag-bot · 2025-05-04T12:50:25Z

jablib/src/test/java/org/jabref/logic/exporter/GroupSerializerTest.java

+    void serializeSmartGroup() {
+        SmartGroup group = new SmartGroup("mySmartGroup", GroupHierarchyType.INDEPENDENT, ',');
+        List<String> serialization = groupSerializer.serializeTree(GroupTreeNode.fromGroup(group));
+        assertEquals(Collections.singletonList("0 SmartGroup:mySmartGroup;0;1;;;;"), serialization);


In JabRef, to create an empty list we use List.of() instead of Collections.emptyList(). This applies to creating single-element lists as well, where List.of() should be preferred for consistency.

trag-bot · 2025-05-04T12:52:07Z

jablib/src/test/java/org/jabref/logic/exporter/GroupSerializerTest.java

+    void serializeSmartGroup() {
+        SmartGroup group = new SmartGroup("mySmartGroup", GroupHierarchyType.INDEPENDENT, ',');
+        List<String> serialization = groupSerializer.serializeTree(GroupTreeNode.fromGroup(group));
+        assertEquals(Collections.singletonList("0 SmartGroup:mySmartGroup;0;1;;;;"), serialization);


Using Collections.singletonList is less modern compared to List.of, which is preferred for creating immutable lists in Java.

Add field to configure imported entries group under web search prefer…

2732800

…ence

paudelritij closed this May 4, 2025

paudelritij force-pushed the fix-for-issue-12548 branch from 2732800 to d9ea011 Compare May 4, 2025 04:20

paudelritij added 3 commits May 4, 2025 13:54

Merge remote-tracking branch 'origin/fix-for-issue-12548' into fix-fo…

badbb25

…r-issue-12548

Merge remote-tracking branch 'origin/fix-for-issue-12548' into fix-fo…

878b42c

…r-issue-12548

Add 'Import entries' group feature for web import entries

91575ba

paudelritij reopened this May 4, 2025

trag-bot bot reviewed May 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Web Import: Add New Entries to 'Imported Entries' Group #12998

Web Import: Add New Entries to 'Imported Entries' Group #12998

paudelritij commented Apr 25, 2025 •

edited

Loading

jabref-machine commented Apr 25, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

jabref-machine commented May 4, 2025

trag-bot bot May 4, 2025

trag-bot bot May 4, 2025

Web Import: Add New Entries to 'Imported Entries' Group #12998

Are you sure you want to change the base?

Web Import: Add New Entries to 'Imported Entries' Group #12998

Conversation

paudelritij commented Apr 25, 2025 • edited Loading

To Do

Done

Mandatory checks

jabref-machine commented Apr 25, 2025

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

jabref-machine commented May 4, 2025

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

trag-bot bot May 4, 2025

Choose a reason for hiding this comment

paudelritij commented Apr 25, 2025 •

edited

Loading